Skip to content

Restructure the Go, Python, and TypeScript Worker pages - #4980

Merged
lennessyy merged 3 commits into
mainfrom
docs/worker-page-structure
Jul 28, 2026
Merged

Restructure the Go, Python, and TypeScript Worker pages#4980
lennessyy merged 3 commits into
mainfrom
docs/worker-page-structure

Conversation

@lennessyy

@lennessyy lennessyy commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Update the run worker page across Go, Python, and TS. This is to make the content more consistent and reference-able for the Serverless worker page for Cloud run. I will follow up with changes to other languages after Cloud Run release and we get more

  1. Create and run a Worker
  2. Register Workflows and Activities
  3. Connect to Temporal Cloud
  4. Configure Worker options
  5. Run a versioned Worker
  6. Shut down a Worker

Dependencies

Snippet bodies are committed inline, so nothing renders broken, but these must merge before a plain yarn snipsync reproduces this content:

That last one turned up while writing this: typescript-hello-worker was defined in three files, and snipsync silently resolved it to sleep-for-days instead of hello-world.

Verification

yarn build passes, confirming every preserved anchor still resolves for its inbound links. vale --config .vale-ci.ini reports 0 errors and 0 warnings; the single suggestion flags "Alpine" in pre-existing content.

Follow-ups

  • The other five SDK Worker pages
  • Heading, anchor, and URL normalization, including the off-pattern Java and Rust URLs, which needs redirects
  • "Run multiple Workers in one process" is undocumented for Go, Python, and TypeScript and has no sample. Left out rather than invented.

Gives all three pages the same six sections, ordered by the reader's
journey: create and run, register types, connect to Cloud, configure
options, run a versioned Worker, shut down.

- Adds a versioned Worker section. None of the eight SDK Worker pages
  documented Worker Versioning.
- Replaces hand-written inline code with snipsync snippets.
- Un-nests the TypeScript register-types section, which was an H3 inside
  the Temporal Cloud section.
- Replaces the TypeScript mTLS-only Cloud walkthrough with a pointer to
  the Client page, which also covers API keys.
- Fills out the Python page, previously a single section.

Existing anchor IDs are preserved because eight other pages link to
them. The TypeScript Docker section is unchanged, moved after the core
sections.
@vercel

vercel Bot commented Jul 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview, Comment Jul 28, 2026 9:46pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

@lennessyy
lennessyy marked this pull request as ready for review July 28, 2026 21:03
@lennessyy
lennessyy requested a review from a team as a code owner July 28, 2026 21:04
@lennessyy
lennessyy merged commit 886b26a into main Jul 28, 2026
13 checks passed
@lennessyy
lennessyy deleted the docs/worker-page-structure branch July 28, 2026 22:42
lennessyy added a commit that referenced this pull request Jul 31, 2026
Follow-up to #4980, applying the same pass done for the other four SDKs.

- Python: the shutdown snippet used interrupt_event, which the page never
  defined. The SNIPSTART boundary in the features repo excludes the enclosing
  function that declares it. Adds the entry point that sets the event.
- Python: run() installs no signal handlers and polls until shutdown() is
  called, so "the Worker runs until the process is interrupted" was inaccurate.
- TypeScript: lowercase the operating system signals. Signal is a Temporal core
  term, so the capitalized form read as a Workflow Signal.
- TypeScript: drop the paragraph in the first section that restated the
  registration rule the next section already states, and document per-Workflow
  versioningBehavior through setWorkflowOptions.
- Go: document DefaultVersioningBehavior, that it requires UseVersioning, and
  that a Workflow with no behavior fails at registration time.
- Go: name the Worker instead of "It" in the shutdown section.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants